HAL TIM migration: List of applicable concepts

This section provides information about the HAL TIM applicable architecture concepts.

Concepts for TIM

Concept	Description
Separation of initialization and configuration functions	The Init and the config are split into 2 level functions: HAL_TIM_Init: initializes the handle and links it to a TIM instance. HAL_TIM_SetConfig: configures the common TIM settings (prescaler, counter mode…).
Removal and conversion of init structure to configuration structure	The init structure has been removed and converted into HAL_TIM_SetConfig function.
Renaming of the handle structure	The handle structure has been renamed to hal_tim_handle_t.
Renaming unitary init structures	The structure TIM_Base_InitTypeDef is no longer available and has been replaced by hal_tim_config_t.
Remove MspInit and MspDeInit callbacks	HAL_TIM_xxx_MspInit and HAL_TIM_xxx_MspDeInit are no longer available and have been replaced by a user sequence to initialize and configure the TIM.
Unitary configuration APIs	New APIs are available to set and get TIM features.
Dedicated DMA link APIs replace generic __HAL_LINKDMA macro	The __HAL_LINKDMA macro is no longer provided and new function HAL_TIM_SetDMA is provided to link a TIM handle to a DMA handle.
Introduction of HAL user data set/get APIs	Two functions to set and get user data are available: HAL_TIM_SetUserData, HAL_TIM_GetUserData.
Individual callback registration APIs replace global register and unregister functions	The callback registration is handled by specific functions for each TIM event. These functions are used to register callback functions for different TIM events.
Introduce specialized IRQ handlers	Global HAL_TIM_IRQHandler still available.In addition, new process-specific handlers HAL_TIM_IRQHandler_<PROCESS> are provided for handling individual processes separately. HAL_TIM_UPD_IRQHandler(): specific to timer update interrupt handler. HAL_TIM_CC_IRQHandler(): specific to timer capture/compare interrupt handler. HAL_TIM_BRK_TERR_IERR_IRQHandler(): specific to timer break, transition error and index error interrupt handler. HAL_TIM_TRGI_COM_DIR_IDX_IRQHandler(): specific to timer trigger, commutation, direction change and index interrupt handler. Note The global HAL_TIM_IRQHandler is the same in all series, but the HAL_TIM_IRQHandler_<PROCESS> by single process differs from one family to another depending on the existence of features precisely: HAL_TIM_BRK_TERR_IERR_IRQHandler() HAL_TIM_TRGI_COM_DIR_IDX_IRQHandler().
HAL implementation with LL inline functions	HAL TIM APIs now rely on LL APIs rather than performing direct register access.
Define statements and enumerations redirected to LL equivalents	HAL TIM define statements and enumerations are based on LL define statements.
Removal of hardware-related macros in HAL2	All hardware macros have been removed from the HAL TIM driver, and equivalent services are ensured through the LL APIs.
Revised and optimized HAL state machine	The TIM now is managed by two state machine : Global state machine Channel state machine : State for the output channel. State for the input channel.
Revised and optimized HAL API status returns	The HAL TIM functions were updated to return: HAL_INVALID_PARAM: in case of a NULL p_config structure pointer. HAL_ERROR: in case of an error. HAL_TIMEOUT: in case of a user timeout. HAL_BUSY: in case of an ongoing process. HAL_OK: in case of a successfully completed operation.
Revised and optimized HAL error management
Replaced TypeDef suffix with _t in type names	All TypeDef parts of the HAL TIM driver have been removed and replaced by _t.
Replaced multi-line macros with inline functions	For the HAL TIM driver, large macros have been replaced by inline functions to maintain code consistency, improve readability, and benefit from compiler optimization. Inline functions also offer better support for debugging and strict type management, reducing the risk of errors.
Replaced nonmodifiable pointers with const keywords	Const keywords have been added to non-modifiable pointers to ensure that either the pointer itself or the data it points to cannot be modified. This enhances code safety and readability, prevents unintended modifications, and renders code more robust and maintainable.
Assertion implementation and usage in HAL1	The parameters and state are checked using ASSERT_DBG_STATE and ASSERT_DBG_PARAM macros.
Merge HAL extension files with common ones and remove the EX prefix from APIs.	Only one HAL TIM header file remains and all macros, define statements, and functions from hal_tim_ex.h have been moved to hal_tim.h.
Add HAL PPP Services for Drivers with Handle to Retrieve Corresponding Peripheral Clock Frequency.	HAL TIM provides new api to retrieve clock frequency HAL_TIM_GetClockFreq()
Replace Finite Parameter Defines (Including PPP Instances) with Enum Types at HAL Levels.	Finite parameters (including TIM instances) have been converted into enumerated types (enums) at HAL level. This improves code readability, maintainability, and type safety.